-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Update chromicons and icon typings #416
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a breaking change to the types?
@swain I was trying to avoid breaking anything. This change reflects the correct types in the newest version of |
@hewayman Your logic all makes sense to me. Only reason I asked: if this is a breaking change, we should mark it as such with a major version bump. You can do that by adding a new commit (or amending your existing one) to match this message syntax:
The |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Swain means a breaking change as in the API is changing which means when consumers of this library upgrade their version of chroma-react, they will need to make some change.
I think we should consider this breaking. I think we should update the peer dependencies to reference the lowest version of chromicons that had the API change, v3.0.0.
A "breaking change" really just means we need to bump the major version of the library. This can be done by commenting with an exclamation mark in the commit after the semmantic tag. i.e. feat!: Update the peer dependency for chromicons
Merging this PR will result in a major version bump. Created by lifeomic-probot (Enforce Semantic Commits) |
🎉 This PR is included in version 6.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
The icon typings here need to be updated so the latest version of
chromicons
can be used in PHC-UI.